neuron Document Experience API icon

neuron Document Experience API

2.0.x
(0 reviews)

Guide - Uploading Large Files

Purpose:

This document describes the step-by-step process for uploading files greater than 100 MB using a multi-phase upload approach.

  1. Initialization
  2. Chunk Upload
  3. Commit

Overview:

Large files are uploaded in chunks to reduce memory usage and handle network interruptions. Below steps are involved when uploading a large files.

  1. Initialize Upload (/init) – Start a new upload session. Refer to the endpoint documentation in the specification section for additional details.

  2. Upload Chunks (/chunk) : Chunking is a method of splitting large files into smaller, manageable pieces, or "chunks," before uploading them. These chunks are uploaded sequentially or in parallel, and once all pieces reach the server, they are reassembled into the original file. This technique optimizes file uploads, making them faster, more reliable, and less prone to failure. Refer to the endpoint documentation in the specification section for additional details.

  3. Commit Upload (/commit) – The commit step must be called to finalize the upload. Commit the chunks using the previously created block ids to complete the document upload process. Refer to the endpoint documentation in the specification section for additional details.

Note: For files of size less than 100 MB, please utilize the POST method of the /submissions/{submissionId} endpoint for documents associated with a submission. For documents associated with a option, please utilize the POST method of the /options/{optionId} endpoint.

⚠️ Deprecation Notice:
The risk and quotes resources, including all their methods and child
endpoints, will be deprecated in a future release.

For all new integrations, please use the /submissions and /options
resources instead. Existing integrations will continue to work until
formal deprecation is announced.

Note: For files of size less than 100 MB, please utilize the POST method of the /risks/{riskId} endpoint for documents associated with a risk. For documents associated with a quote, please utilize the POST method of the /quotes/{quoteId} endpoint.

Reviews